14.2.2 REST Device Cancelled notification

The REST Device Cancelled event sends a notification to a REST web service when a device is canceled and therefore removed from association with any people. This may be caused by a variety of operations; for example, canceling a device, erasing a device, or reaching a limit of devices per person, for example.

If you configure an external system with the name REST Device Cancelled and specify the corresponding mapping file RESTDeviceCancelled.xml, you can configure MyID to respond to the event with the following.

14.2.2.1 Endpoint

POST /devices/{device GUID}/deviceCancelled

{
    "person": {
        "id": "<person guid>",
        "group": {
            "id": "<group guid>",
            "name": "<group name>"
        },
        "name": {
            "first": "<first name>",
            "last": "<surname>"
        },
        "contact":
        {
            "emailAddress":"<email address>"
        },
        "employeeId":"<employee ID / security number>"
    },
    "device": {
        "id": "<device guid>",
        "sn": "<device serial number>",
        "dt": "<MyID device type>",
        "hid": {
            "serialNumber": "<HID loop ID>",
            "facilityCode": "<HID facility code>"
        }
    }
}